Storyteller SDK Documentation/com.storyteller.domain.entities

Package-level declarations

Types

Link copied to clipboard
typealias StorytellerAnalyticsContext = HashMap<String, String>

A typealias for a HashMap containing string key-value pairs used to provide optional integrator-defined context for Storyteller UI instances.

Link copied to clipboard
sealed class StorytellerDisabledFunctionalFeature

Represents functional features that can be disabled in the Storyteller SDK.

Link copied to clipboard
sealed class StorytellerError : Exception

Represents a base class for all errors that can occur within the Storyteller SDK. Each specific error type provides more context about the issue encountered.

Link copied to clipboard
enum StorytellerListViewCellType : Enum<StorytellerListViewCellType>

Defines the visual style of individual cells within a Storyteller list view. Each cell type corresponds to a specific visual representation for Story or Clip items. For more information on configuring list appearance, see the Storyteller Lists Documentation.

Link copied to clipboard
enum StorytellerListViewStyle : Enum<StorytellerListViewStyle>

Defines the overall theme style for a Storyteller list view. This allows forcing a light or dark theme, or automatically matching the system theme. For more information on configuring list appearance, see the Storyteller Lists Documentation.

Link copied to clipboard
@Serializable
data class StorytellerUserActivity(id: Long = Random.nextLong(), type: StorytellerUserActivity.EventType, externalId: String? = null, val adView: View? = null, val storyId: String? = null, val storyIndex: Int? = null, val storyTitle: String? = null, val storyDisplayTitle: String? = null, val storyReadStatus: String? = null, val storyPageCount: Int? = null, val isMuted: Boolean? = null, val clipId: String? = null, val clipTitle: String? = null, val clipIndex: Int? = null, val clipActionType: String? = null, val clipHasAction: Boolean? = null, val clipActionUrl: String? = null, val clipActionText: String? = null, val actionClass: String? = null, val actionIndex: Int? = null, val tappedClipActionText: String? = null, val tappedClipActionUrl: String? = null, val tappedClipActionType: String? = null, val clipHasSecondaryActions: Boolean? = null, val clipSecondaryActionsText: List<String>? = null, val clipSecondaryActionUrls: List<String>? = null, val clipSecondaryActionTypes: List<String>? = null, val clipsViewed: Int? = null, val loopsViewed: Int? = null, val clipFeedType: String? = null, val collectionClipCount: Int? = null, val collectionOffset: Int? = null, val originalPosition: Int? = null, val displayPosition: Int? = null, val captionsEnabled: Boolean? = null, val startPosition: Long? = null, val endPosition: Long? = null, val scrubDirection: String? = null, val completionType: String? = null, val pageId: String? = null, val pageType: String? = null, val pageIndex: Int? = null, val pageTitle: String? = null, val pageActionType: String? = null, val pageHasAction: Boolean? = null, val pageActionText: String? = null, val pageActionUrl: String? = null, val pagesViewedCount: Int? = null, val contentLength: Long? = null, val itemTitle: String? = null, val actionText: String? = null, val actionLinkId: String? = null, val containerTitle: String? = null, val searchFrom: String? = null, val searchTerm: String? = null, val searchSort: String? = null, val searchFilter: String? = null, val initialInput: String? = null, val isSuggestion: Boolean? = null, val storyPlaybackMode: String? = null, val openedReason: String? = null, val dismissedReason: String? = null, val isInitialBuffering: Boolean? = null, val timeSinceBufferingBegan: Long? = null, val durationViewed: Float? = null, val isLive: Boolean? = null, val adId: String? = null, val advertiserName: String? = null, val adType: String? = null, val adFormat: String? = null, val adResponseIdentifier: String? = null, val adPlacement: String? = null, val adStrategy: String? = null, val adIndex: Int? = null, val pollAnswerId: String? = null, val triviaQuizAnswerId: String? = null, val triviaQuizId: String? = null, val triviaQuizQuestionId: String? = null, val triviaQuizTitle: String? = null, val triviaQuizScore: Int? = null, val shareMethod: String? = null, val categories: List<String>? = null, val collection: String? = null, val currentCategory: StorytellerCategory? = null, val categoryId: String? = null, val categoryName: String? = null, val categoryType: String? = null, val location: String? = null, val categoryDetails: List<StorytellerCategory>? = null, val excludeFromAnalytics: Boolean? = null, val player: Any? = null, val metadata: Map<String, String>? = null, val sheetId: String? = null, val sheetSize: Int? = null, val sheetTitle: String? = null, val cardActionType: String? = null, val cardActionUrl: String? = null, val cardAspectRatio: String? = null, val cardBackgroundType: String? = null, val cardCollectionId: String? = null, val cardId: String? = null, val cardIndex: Int? = null, val cardSubtitle: String? = null, val cardTitle: String? = null, val hasButton: Boolean? = null, val screenResolution: String? = null, val appId: String? = null, val appName: String? = null, val deviceModel: String? = null, val appVersion: String? = null, val operatingSystem: String? = null, val osVersion: String? = null, val deviceType: String? = null, val deviceBrand: String? = null, val targetOsVersion: String? = null, val minOsVersion: String? = null, val languageVersion: String? = null, val initializationSucceeded: Boolean? = null, val enablePersonalization: Boolean? = null, val enableStorytellerTracking: Boolean? = null, val enableUserActivityTracking: Boolean? = null, val enableAdTracking: Boolean? = null, val enableFullVideoAnalytics: Boolean? = null, val enableRemoteViewingStore: Boolean? = null, val eyebrow: String? = null, val followableCategoryLimitActionText: String? = null, val followableCategoryLimitActionUrl: String? = null, val followableCategoryLimitDialogue: String? = null, val context: StorytellerAnalyticsContext? = null) : BaseUserActivity
Link copied to clipboard
@Serializable
data class StorytellerUserInput(val externalId: String)

Represents user-specific input required for initializing the Storyteller SDK. This class is used to pass user identification information to the SDK. For more details on managing user information, see the Storyteller User Management Documentation.

Link copied to clipboard